Docs
put https://api.pix.iugu.com/api/v2/webhook/{chave}

Configurar o Webhook Pix.

Endpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados.

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Schema Obrigatório

Tipo de conteúdo: application/json
webhookUrl

Obrigatório

String

Ex: https://pix.example.com/api/webhook/
Exemplo 
1
2
3

{
  "webhookUrl": "https://pix.example.com/api/webhook/"
}

Parâmetros de Path

  • chave

    Obrigatório

    String <= 77 characters

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
Webhook para notificações acerca de Pix recebidos associados a um txid.
400
Requisição com formato inválido.
type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
title
String

Descrição resumida do problema.

Ex: Not found
status
Integer

Código HTTP do status retornado.

Ex: 404
detail
String

Descrição completa do problema.
correlationId
String

Identificador de correlação do problema para fins de suporte
violacoes
Array of objects

403
Requisição de participante autenticado que viola alguma regra de autorização.
type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
title
String

Descrição resumida do problema.

Ex: Not found
status
Integer

Código HTTP do status retornado.

Ex: 404
detail
String

Descrição completa do problema.
correlationId
String

Identificador de correlação do problema para fins de suporte
violacoes
Array of objects

404
Recurso solicitado não foi encontrado.
type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
title
String

Descrição resumida do problema.

Ex: Not found
status
Integer

Código HTTP do status retornado.

Ex: 404
detail
String

Descrição completa do problema.
correlationId
String

Identificador de correlação do problema para fins de suporte
violacoes
Array of objects

503
Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.
type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
title
String

Descrição resumida do problema.

Ex: Not found
status
Integer

Código HTTP do status retornado.

Ex: 404
detail
String

Descrição completa do problema.
correlationId
String

Identificador de correlação do problema para fins de suporte
violacoes
Array of objects

Voltar

Desvincular uma cobrança de uma location.

Avançar

Exibir informações acerca do Webhook Pix.